Skip to content

Documenting that expandTo conserves mass not number of atoms - #2645

Merged
john-science merged 1 commit into
mainfrom
doc_expandTo
Aug 28, 2026
Merged

Documenting that expandTo conserves mass not number of atoms#2645
john-science merged 1 commit into
mainfrom
doc_expandTo

Conversation

@john-science

@john-science john-science commented Aug 27, 2026

Copy link
Copy Markdown
Member

What is the change? Why is it being made?

There was some confusion that using the expandTo feature in the nuclide flags section of the blueprints does not conserve the number of atoms. But that is because it conserves the total mass of the element instead. (And you can only do one.)

Now, this was mentioned in a docstring somewhere, but the request was made to warn people in the documentation. Which is fair, and this PR accomplishes that.

close #1817

SCR Information

Change Type: fixes

One-Sentence Rationale: People should know what kind is conserved when they use the expandTo feature in nuclide flags.

One-line Impact on Requirements: NA


Checklist

@john-science
john-science requested a review from keckler August 27, 2026 17:50
@john-science john-science added bug Modeling results may be incorrect: Highest Priority documentation Improvements or additions to documentation labels Aug 27, 2026
@john-science
john-science merged commit bded87f into main Aug 28, 2026
4 checks passed
@john-science
john-science deleted the doc_expandTo branch August 28, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Modeling results may be incorrect: Highest Priority documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

expandTo in nuclide flags produces different number densities than using elemental nuclide

2 participants